gtktypeutils: move documentation to inline comments
authorJavier Jardón <jjardon@gnome.org>
Wed, 1 Sep 2010 17:36:19 +0000 (19:36 +0200)
committerJavier Jardón <jjardon@gnome.org>
Wed, 1 Sep 2010 18:37:39 +0000 (20:37 +0200)
docs/reference/gtk/tmpl/.gitignore
docs/reference/gtk/tmpl/gtktypeutils.sgml [deleted file]
gtk/gtktypeutils.c
gtk/gtktypeutils.h

index d19042e8db6ee7c2d6b56a113d0147e3c7c6cb2c..c9a1746bfc16e7f5bd30046a5f17e374d95a0612 100644 (file)
@@ -34,4 +34,5 @@ gtktextiter.sgml
 gtktoggleaction.sgml
 gtktoolitem.sgml
 gtktreednd.sgml
+gtktypeutils.sgml
 gtkwindow.sgml
diff --git a/docs/reference/gtk/tmpl/gtktypeutils.sgml b/docs/reference/gtk/tmpl/gtktypeutils.sgml
deleted file mode 100644 (file)
index 69a4a26..0000000
+++ /dev/null
@@ -1,51 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-Types
-
-<!-- ##### SECTION Short_Description ##### -->
-Handle run-time type creation
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-The GTK+ type system is extensible.  Because of that, types have to be
-managed at runtime.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### USER_FUNCTION GtkFunction ##### -->
-<para>
-Defines a function pointer.
-</para>
-
-@data: #gpointer
-@Returns: #gint
-
-
-<!-- ##### USER_FUNCTION GtkCallbackMarshal ##### -->
-<para>
-Defines a function pointer.
-</para>
-
-@object: #GtkObject*
-@data: #gpointer
-@n_args: #guint
-@args: #GtkArg*
-
-
-<!-- ##### STRUCT GtkArg ##### -->
-<para>
-This is a structure that we use to pass in typed values (and names).
-</para>
-
-@type: 
-@name: 
-
index 1d6f9b44e46e7bf4fde0677cc0567db56ed734d9..ea30f06e67d7a60b612aff6f83d05df9abe76cc0 100644 (file)
 #include "gtkintl.h"
 
 
+/**
+ * SECTION:gtktypeutils
+ * @Short_description: Handle run-time type creation
+ * @Title: Types
+ *
+ * The GTK+ type system is extensible.  Because of that, types have to be
+ * managed at runtime.
+ */
+
+
 GType
 gtk_identifier_get_type (void)
 {
index 75711a3f4ac45d8324921976f1e1a9d18b4c9811..883266e116584ff396c830f550c3ec3a395b4f83 100644 (file)
@@ -47,7 +47,26 @@ GType gtk_identifier_get_type (void) G_GNUC_CONST;
  */
 typedef struct _GtkArg              GtkArg;
 typedef struct _GtkObject           GtkObject; /* object forward declaration */
+
+/**
+ * GtkFunction:
+ * @data: #gpointer
+ *
+ * Defines a function pointer.
+ *
+ * Returns: #gint
+ */
 typedef gboolean (*GtkFunction)            (gpointer      data);
+
+/**
+ * GtkCallbackMarshal:
+ * @object: #GtkObject*
+ * @data: #gpointer
+ * @n_args: #guint
+ * @args: #GtkArg*
+ *
+ * Defines a function pointer.
+ */
 typedef void (*GtkCallbackMarshal)  (GtkObject    *object,
                                     gpointer      data,
                                     guint         n_args,
@@ -60,7 +79,11 @@ typedef gchar * (*GtkTranslateFunc) (const gchar  *path,
                                     gpointer      func_data);
 
 #if defined (GTK_COMPILATION)
-/* GtkArg, used to hold differently typed values */
+/**
+ * GtkArg:
+ *
+ * This is a structure that we use to pass in typed values (and names).
+ */
 struct _GtkArg
 {
   GType type;